/*****************************************************************************
 * Copyright (c) 2019, Nations Technologies Inc.
 *
 * All rights reserved.
 * ****************************************************************************
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the disclaimer below.
 *
 * Nations' name may not be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * DISCLAIMER: THIS SOFTWARE IS PROVIDED BY NATIONS "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE
 * DISCLAIMED. IN NO EVENT SHALL NATIONS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
 * OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * ****************************************************************************/

/**
 * @file n32g45x_rng.h
 * @author Nations Solution Team
 * @version v1.0.0
 *
 * @copyright Copyright (c) 2019, Nations Technologies Inc. All rights reserved.
 */
#ifndef __N32G45X_RNG_H__
#define __N32G45X_RNG_H__

#include <stdint.h>

/** @addtogroup N32G45X_Algorithm_Library
 * @{
 */

/** @addtogroup RNG
 * @brief Random number generator
 * @{
 */

enum
{
    RNG_OK     = 0x5a5a5a5a,
    LENError   = 0x311ECF50, // RNG generation of key length error
    ADDRNULL   = 0x7A9DB86C, // This address is empty
};

/**
 * @brief Get pseudo random number
 * @param[out] rand pointer to random number
 * @param[in] wordLen the wordlen of random number
 * @param[in] seed the seed, can be NULL
 * @return RNG_OK:get random number success; othets: get random number fail
 * @note
 */
uint32_t GetPseudoRand_U32(uint32_t* rand, uint32_t wordLen, uint32_t seed[2]);

/**
 * @brief Get true random number
 * @param[out] rand pointer to random number
 * @param[in] wordLen the wordlen of random number
 * @return RNG_OK:get random number success; othets: get random number fail
 * @note
 */
uint32_t GetTrueRand_U32(uint32_t* rand, uint32_t wordLen);

/**
 * @brief Get RNG lib version
 * @param[out] type pointer one byte type information represents the type of the lib, like Commercial version.\
 * Bits 0~4 stands for Commercial (C), Security (S), Normal (N), Evaluation (E), Test (T), Bits 5~7 are reserved. e.g.
 * 0x09 stands for CE version.
 * @param[out] customer pointer one byte customer information represents customer ID. for example, 0x00 stands for
 * standard version, 0x01 is for Tianyu customized version...
 * @param[out] date pointer array which include three bytes date information. If the returned bytes are 18,9,13,this
 * denotes September 13,2018
 * @param[out] version pointer one byte version information represents develop version of the lib. e.g. 0x12 denotes
 * version 1.2.
 * @1.You can recall this function to get RSA lib information
 */
void RNG_Version(uint8_t* type, uint8_t* customer, uint8_t date[3], uint8_t* version);

/**
 * @}
 */

/**
 * @}
 */
#endif
